table of contents
VACUUMDB(1) | PostgreSQL 9.2.24 Documentation | VACUUMDB(1) |
NAME¶
vacuumdb - garbage-collect and analyze a PostgreSQL database
SYNOPSIS¶
vacuumdb [connection-option...] [option...] [--table | -t table [( column [,...] )]] [dbname]
vacuumdb [connection-option...] [option...] --all | -a
DESCRIPTION¶
vacuumdb is a utility for cleaning a PostgreSQL database. vacuumdb will also generate internal statistics used by the PostgreSQL query optimizer.
vacuumdb is a wrapper around the SQL command VACUUM(7). There is no effective difference between vacuuming and analyzing databases via this utility and via other methods for accessing the server.
OPTIONS¶
vacuumdb accepts the following command-line arguments:
-a, --all
[-d] dbname, [--dbname=]dbname
-e, --echo
-f, --full
-F, --freeze
-q, --quiet
-t table [ (column [,...]) ], --table=table [ (column [,...]) ]
Tip
If you specify columns, you probably have to escape the parentheses from the shell. (See examples below.)
-v, --verbose
-V, --version
-z, --analyze
-Z, --analyze-only
-?, --help
vacuumdb also accepts the following command-line arguments for connection parameters:
-h host, --host=host
-p port, --port=port
-U username, --username=username
-w, --no-password
-W, --password
This option is never essential, since vacuumdb will automatically prompt for a password if the server demands password authentication. However, vacuumdb will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt.
--maintenance-db=dbname
ENVIRONMENT¶
PGDATABASE, PGHOST, PGPORT, PGUSER
This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 31.14, “Environment Variables”, in the documentation).
DIAGNOSTICS¶
In case of difficulty, see VACUUM(7) and psql(1) for discussions of potential problems and error messages. The database server must be running at the targeted host. Also, any default connection settings and environment variables used by the libpq front-end library will apply.
NOTES¶
vacuumdb might need to connect several times to the PostgreSQL server, asking for a password each time. It is convenient to have a ~/.pgpass file in such cases. See Section 31.15, “The Password File”, in the documentation for more information.
EXAMPLES¶
To clean the database test:
$ vacuumdb test
To clean and analyze for the optimizer a database named bigdb:
$ vacuumdb --analyze bigdb
To clean a single table foo in a database named xyzzy, and analyze a single column bar of the table for the optimizer:
$ vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy
SEE ALSO¶
2017-11-06 | PostgreSQL 9.2.24 |